Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automated SDK generation @ aws-cloudformation-user-guide 19dc52cd3f2007d6d268b65b739ffb5ebf8c1e76 #1932

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .docs.version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
66b7511f59401ec2374398c60cfe4f31e35bb6e6
57dbfec7bac5446b44cf85667093cf9a9f3199f8
126 changes: 88 additions & 38 deletions aws-cloudformation-schema/aws-appconfig-deployment.json
Original file line number Diff line number Diff line change
@@ -1,78 +1,128 @@
{
"tagging" : {
"permissions" : [ "appconfig:TagResource", "appconfig:UntagResource", "appconfig:ListTagsForResource" ],
"taggable" : true,
"tagOnCreate" : true,
"tagUpdatable" : false,
"tagProperty" : "/properties/Tags",
"cloudFormationSystemTags" : true
},
"typeName" : "AWS::AppConfig::Deployment",
"readOnlyProperties" : [ "/properties/DeploymentNumber" ],
"description" : "Resource Type definition for AWS::AppConfig::Deployment",
"createOnlyProperties" : [ "/properties/ApplicationId", "/properties/ConfigurationProfileId", "/properties/DeploymentStrategyId", "/properties/EnvironmentId", "/properties/Description", "/properties/ConfigurationVersion", "/properties/KmsKeyIdentifier", "/properties/DynamicExtensionParameters", "/properties/Tags" ],
"primaryIdentifier" : [ "/properties/ApplicationId", "/properties/EnvironmentId", "/properties/DeploymentNumber" ],
"required" : [ "ApplicationId", "ConfigurationProfileId", "DeploymentStrategyId", "EnvironmentId", "ConfigurationVersion" ],
"sourceUrl" : "https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git",
"handlers" : {
"read" : {
"permissions" : [ "appconfig:GetDeployment", "appconfig:ListTagsForResource" ]
},
"create" : {
"permissions" : [ "appconfig:StartDeployment", "appconfig:GetDeployment", "appconfig:TagResource", "appconfig:ListTagsForResource", "kms:GenerateDataKey" ],
"timeoutInMinutes" : 1445
},
"list" : {
"permissions" : [ "appconfig:ListDeployments" ],
"handlerSchema" : {
"properties" : {
"EnvironmentId" : {
"$ref" : "resource-schema.json#/properties/EnvironmentId"
},
"ApplicationId" : {
"$ref" : "resource-schema.json#/properties/ApplicationId"
}
},
"required" : [ "ApplicationId", "EnvironmentId" ]
}
},
"delete" : {
"permissions" : [ "appconfig:StopDeployment" ]
}
},
"writeOnlyProperties" : [ "/properties/DynamicExtensionParameters" ],
"additionalProperties" : false,
"definitions" : {
"Tag" : {
"description" : "Metadata to assign to the deployment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.",
"additionalProperties" : false,
"type" : "object",
"properties" : {
"Value" : {
"description" : "The tag value can be up to 256 characters.",
"type" : "string"
},
"Key" : {
"description" : "The key-value string map. The valid character set is [a-zA-Z1-9+-=._:/]. The tag key can be up to 128 characters and must not start with aws:.",
"type" : "string"
}
}
},
"DynamicExtensionParameters" : {
"additionalProperties" : false,
"type" : "object",
"properties" : {
"ParameterValue" : {
"type" : "string"
},
"ExtensionReference" : {
"type" : "string"
},
"ParameterName" : {
"type" : "string"
}
}
}
},
"properties" : {
"DeploymentStrategyId" : {
"description" : "The deployment strategy ID.",
"type" : "string"
},
"ConfigurationProfileId" : {
"description" : "The configuration profile ID.",
"type" : "string"
},
"EnvironmentId" : {
"description" : "The environment ID.",
"type" : "string"
},
"KmsKeyIdentifier" : {
"pattern" : "^[\\da-f]{8}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{4}-[\\da-f]{12}|alias/[a-zA-Z0-9/_-]{1,250}|arn:aws[a-zA-Z-]*:kms:[a-z]{2}(-gov|-iso(b?))?-[a-z]+-\\d{1}:\\d{12}:(key/[0-9a-f-]{36}|alias/[a-zA-Z0-9/_-]{1,250})$",
"description" : "The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.",
"type" : "string"
},
"Description" : {
"description" : "A description of the deployment.",
"type" : "string"
},
"ConfigurationVersion" : {
"description" : "The configuration version to deploy. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.",
"type" : "string"
},
"Id" : {
"DeploymentNumber" : {
"description" : "The sequence number of the deployment.",
"type" : "string"
},
"ApplicationId" : {
"description" : "The application ID.",
"type" : "string"
},
"DynamicExtensionParameters" : {
"type" : "array",
"uniqueItems" : false,
"type" : "array",
"items" : {
"$ref" : "#/definitions/DynamicExtensionParameters"
}
},
"Tags" : {
"uniqueItems" : true,
"description" : "An array of key-value pairs to apply to this resource.",
"insertionOrder" : false,
"type" : "array",
"uniqueItems" : false,
"items" : {
"$ref" : "#/definitions/Tags"
}
}
},
"definitions" : {
"DynamicExtensionParameters" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"ExtensionReference" : {
"type" : "string"
},
"ParameterName" : {
"type" : "string"
},
"ParameterValue" : {
"type" : "string"
}
}
},
"Tags" : {
"type" : "object",
"additionalProperties" : false,
"properties" : {
"Value" : {
"type" : "string"
},
"Key" : {
"type" : "string"
}
"$ref" : "#/definitions/Tag"
}
}
},
"required" : [ "DeploymentStrategyId", "ConfigurationProfileId", "EnvironmentId", "ConfigurationVersion", "ApplicationId" ],
"createOnlyProperties" : [ "/properties/KmsKeyIdentifier", "/properties/DeploymentStrategyId", "/properties/ConfigurationVersion", "/properties/ApplicationId", "/properties/ConfigurationProfileId", "/properties/Tags", "/properties/EnvironmentId", "/properties/Description", "/properties/DynamicExtensionParameters" ],
"primaryIdentifier" : [ "/properties/Id" ],
"readOnlyProperties" : [ "/properties/Id" ]
}
}
36 changes: 23 additions & 13 deletions aws-cloudformation-schema/aws-bedrock-datasource.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
},
"ParsingPrompt" : {
"$ref" : "#/definitions/ParsingPrompt"
},
"ParsingModality" : {
"$ref" : "#/definitions/ParsingModality"
}
},
"required" : [ "ModelArn" ],
Expand Down Expand Up @@ -91,17 +94,6 @@
}
},
"required" : [ "Type" ],
"oneOf" : [ {
"required" : [ "S3Configuration" ]
}, {
"required" : [ "ConfluenceConfiguration" ]
}, {
"required" : [ "SalesforceConfiguration" ]
}, {
"required" : [ "SharePointConfiguration" ]
}, {
"required" : [ "WebConfiguration" ]
} ],
"additionalProperties" : false
},
"DataSourceStatus" : {
Expand All @@ -112,7 +104,7 @@
"DataSourceType" : {
"type" : "string",
"description" : "The type of the data source location.",
"enum" : [ "S3", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "WEB" ]
"enum" : [ "S3", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "WEB", "CUSTOM" ]
},
"DataDeletionPolicy" : {
"type" : "string",
Expand Down Expand Up @@ -195,11 +187,29 @@
},
"BedrockFoundationModelConfiguration" : {
"$ref" : "#/definitions/BedrockFoundationModelConfiguration"
},
"BedrockDataAutomationConfiguration" : {
"$ref" : "#/definitions/BedrockDataAutomationConfiguration"
}
},
"required" : [ "ParsingStrategy" ],
"additionalProperties" : false
},
"ParsingModality" : {
"type" : "string",
"description" : "Determine how will parsed content be stored.",
"enum" : [ "MULTIMODAL" ]
},
"BedrockDataAutomationConfiguration" : {
"type" : "object",
"description" : "Settings for a Bedrock Data Automation used to parse documents for a data source.",
"properties" : {
"ParsingModality" : {
"$ref" : "#/definitions/ParsingModality"
}
},
"additionalProperties" : false
},
"ParsingPrompt" : {
"type" : "object",
"description" : "Instructions for interpreting the contents of a document.",
Expand All @@ -217,7 +227,7 @@
"ParsingStrategy" : {
"type" : "string",
"description" : "The parsing strategy for the data source.",
"enum" : [ "BEDROCK_FOUNDATION_MODEL" ]
"enum" : [ "BEDROCK_FOUNDATION_MODEL", "BEDROCK_DATA_AUTOMATION" ]
},
"S3DataSourceConfiguration" : {
"type" : "object",
Expand Down
83 changes: 80 additions & 3 deletions aws-cloudformation-schema/aws-bedrock-knowledgebase.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@
},
"VectorKnowledgeBaseConfiguration" : {
"$ref" : "#/definitions/VectorKnowledgeBaseConfiguration"
},
"KendraKnowledgeBaseConfiguration" : {
"$ref" : "#/definitions/KendraKnowledgeBaseConfiguration"
}
},
"required" : [ "Type", "VectorKnowledgeBaseConfiguration" ],
"required" : [ "Type" ],
"additionalProperties" : false
},
"KnowledgeBaseStatus" : {
Expand All @@ -29,7 +32,7 @@
"KnowledgeBaseType" : {
"type" : "string",
"description" : "The type of a knowledge base.",
"enum" : [ "VECTOR" ]
"enum" : [ "VECTOR", "KENDRA" ]
},
"OpenSearchServerlessConfiguration" : {
"type" : "object",
Expand Down Expand Up @@ -401,10 +404,84 @@
},
"EmbeddingModelConfiguration" : {
"$ref" : "#/definitions/EmbeddingModelConfiguration"
},
"SupplementalDataStorageConfiguration" : {
"$ref" : "#/definitions/SupplementalDataStorageConfiguration"
}
},
"required" : [ "EmbeddingModelArn" ],
"additionalProperties" : false
},
"S3Location" : {
"type" : "object",
"description" : "An Amazon S3 location.",
"properties" : {
"URI" : {
"type" : "string",
"maxLength" : 2048,
"minLength" : 1,
"pattern" : "^s3://.{1,128}$",
"description" : "The location's URI"
}
},
"required" : [ "URI" ],
"additionalProperties" : false
},
"SupplementalDataStorageLocationType" : {
"type" : "string",
"description" : "Supplemental data storage location type.",
"enum" : [ "S3" ]
},
"SupplementalDataStorageLocation" : {
"type" : "object",
"description" : "Supplemental data storage location.",
"properties" : {
"SupplementalDataStorageLocationType" : {
"$ref" : "#/definitions/SupplementalDataStorageLocationType"
},
"S3Location" : {
"$ref" : "#/definitions/S3Location"
}
},
"required" : [ "SupplementalDataStorageLocationType" ],
"additionalProperties" : false
},
"SupplementalDataStorageLocations" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SupplementalDataStorageLocation"
},
"maxItems" : 1,
"minItems" : 1,
"description" : "List of supplemental data storage locations.",
"insertionOrder" : false
},
"SupplementalDataStorageConfiguration" : {
"type" : "object",
"description" : "Configurations for supplemental data storage.",
"properties" : {
"SupplementalDataStorageLocations" : {
"$ref" : "#/definitions/SupplementalDataStorageLocations"
}
},
"required" : [ "SupplementalDataStorageLocations" ],
"additionalProperties" : false
},
"KendraKnowledgeBaseConfiguration" : {
"type" : "object",
"description" : "Configurations for a Kendra knowledge base",
"properties" : {
"KendraIndexArn" : {
"$ref" : "#/definitions/KendraIndexArn"
}
},
"required" : [ "KendraIndexArn" ],
"additionalProperties" : false
},
"KendraIndexArn" : {
"type" : "string",
"description" : "Arn of a Kendra index",
"pattern" : "^arn:aws(|-cn|-us-gov):kendra:[a-z0-9-]{1,20}:([0-9]{12}|):index/([a-zA-Z0-9][a-zA-Z0-9-]{35}|[a-zA-Z0-9][a-zA-Z0-9-]{35}-[a-zA-Z0-9][a-zA-Z0-9-]{35})$"
}
},
"properties" : {
Expand Down Expand Up @@ -469,7 +546,7 @@
"$ref" : "#/definitions/TagsMap"
}
},
"required" : [ "KnowledgeBaseConfiguration", "Name", "RoleArn", "StorageConfiguration" ],
"required" : [ "KnowledgeBaseConfiguration", "Name", "RoleArn" ],
"readOnlyProperties" : [ "/properties/KnowledgeBaseId", "/properties/KnowledgeBaseArn", "/properties/CreatedAt", "/properties/UpdatedAt", "/properties/FailureReasons", "/properties/Status" ],
"createOnlyProperties" : [ "/properties/StorageConfiguration", "/properties/KnowledgeBaseConfiguration" ],
"primaryIdentifier" : [ "/properties/KnowledgeBaseId" ],
Expand Down
Loading
Loading