CmdID

CmdID / aws / aws greengrass

aws greengrass create-core-definition

Creates a core definition. AWS CLI reference

2 examples 4 options Its page in the AWS CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Examples

from aws-cli, each command read by CmdID

Example 1: To create an empty core definition

The following create-core-definition example creates an empty (no initial version) Greengrass core definition. Before the core is usable, you must use the create-core-definition-version command to provide the other parameters for the core.

aws greengrass create-core-definition --name cliGroup_CoreIdentify
--nameThe name of the core definition.
Its output
{
    "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "CreationTimestamp": "2019-06-25T18:23:22.106Z",
    "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "LastUpdatedTimestamp": "2019-06-25T18:23:22.106Z",
    "Name": "cliGroup_Core"
}

Example 2: To create a core definition with an initial version

The following create-core-definition example creates a core definition that contains an initial core definition version. The version can contain one core only. Before you can create a core, you must first create and provision the corresponding AWS IoT thing. This process includes the following iot commands, which return the ThingArn and CertificateArn required for the create-core-definition command.

* Create the AWS IoT thing that corresponds to the core device.

aws iot create-thing --thing-name "MyCoreDevice"Identify
--thing-nameThe name of the thing to create.
Its output
{
    "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice",
    "thingName": "MyCoreDevice",
    "thingId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}

* Create public and private keys and the core device certificate for the thing. This example uses the create-keys-and-certificate command and requires write permissions to the current directory. Alternatively, you can use the create-certificate-from-csr command.

aws iot create-keys-and-certificate --set-as-active --certificate-pem-outfile "myCore.cert.pem" --public-key-outfile "myCore.public.key" --private-key-outfile "myCore.private.key"Identify
--set-as-activeSpecifies whether the certificate is active.
Its output
{
    "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz",
    "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n",
    "keyPair": {
        "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n",
        "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n"
    },
    "certificateId": "123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz"
}

* Create an AWS IoT policy that allows iot and greengrass actions. For simplicity, the following policy allows actions on all resources, but your policy should be more restrictive.

aws iot create-policy --policy-name "Core_Devices" --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}"Identify
--policy-nameThe policy name.
--policy-documentThe JSON document that describes the policy.
Its output
{
    "policyName": "Core_Devices",
    "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/Core_Devices",
    "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}",
    "policyVersionId": "1"
}

* Attach the policy to the certificate.

aws iot attach-policy --policy-name "Core_Devices" --target "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz"Identify
--policy-nameThe name of the policy to attach.
--targetThe identity to which the policy is attached.

This command produces no output.

* Attach the thing to the certificate.

aws iot attach-thing-principal --thing-name "MyCoreDevice" --principal "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz"Identify
--thing-nameThe name of the thing.
--principalThe principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

This command produces no output.

* Create the core definition.

aws greengrass create-core-definition --name "MyCores" --initial-version "{\"Cores\":[{\"Id\":\"MyCoreDevice\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz\",\"SyncShadow\":true}]}"Identify
--nameThe name of the core definition.
--initial-versionInformation about the initial version of the core definition.
Its output
{
    "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333/versions/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
    "Name": "MyCores",
    "LastUpdatedTimestamp": "2019-09-18T00:11:06.197Z",
    "LatestVersion": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
    "CreationTimestamp": "2019-09-18T00:11:06.197Z",
    "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
    "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"
}

For more information, see Configure the AWS IoT Greengrass core in the AWS IoT Greengrass Developer Guide.

Options

4 in the AWS CLI reference
--amzn-client-tokenA client token used to correlate requests and responses.
--initial-versionInformation about the initial version of the core definition.
--nameThe name of the core definition.
--tagsTag(s) to add to the new resource.